/*
 * File Name     : @(#)IEvent.java
 * Creation Date : Mar 2, 2009
 * Author        : anirudh
 * 
 * Copyright 2009 Anirudh Vyas
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hcis.core.engine.event;

import hcis.core.engine.phase.config.impl.PhaseType;
import hcis.dto.IDTO;
import hcis.model.IModel;
import hcis.model.annotation.HCISEntity;

import java.io.Serializable;

/**
 * An event occurance is equivalent to a business use case execution. Each event though must occur on certain type of model, a fictitious example would be CreateEvent occuring on Account model will be
 * known as CreateAccountModelEvent (common-sense agreeable naming convention).
 * 
 * @author avyas
 * @param <SOURCE>
 *            source type.
 * @param <MODEL>
 *            model type.
 * @param <ID>
 *            id type.
 */
@HCISEntity
public interface IEvent<SOURCE extends IDTO<MODEL, ID>, MODEL extends IModel<ID>, ID extends Serializable> extends Serializable {

	/**
	 * Gets the source of the event.
	 * 
	 * @return source of the event to get.
	 */
	public abstract SOURCE getSource();

	/**
	 * Sets the event of source.
	 * 
	 * @param pSource
	 *            source of the event to set.
	 */
	public abstract void setSource(final SOURCE pSource);

	/**
	 * Gets the event type.
	 * 
	 * @return event type to get.
	 */
	public abstract EventType getType();

	/**
	 * Gets the bound model for the event.
	 * 
	 * @return bound model for the event to get.
	 */
	public abstract MODEL getBoundModel();

	/**
	 * Sets the bound model.
	 * 
	 * @param pModel
	 *            bound model to set.
	 */
	public abstract void setBoundModel(final MODEL pModel);

	/**
	 * Gets the phase type.
	 * 
	 * @return phase type for the event to get.
	 */
	public abstract PhaseType getPhaseType();

	/**
	 * Event type enumerations.
	 * 
	 * @author avyas
	 */
	public static enum EventType {

		/**
		 * CREATE event.
		 */
		CREATE,

		/**
		 * READ Event.
		 */
		READ,

		/**
		 * UPDATE Event.
		 */
		UPDATE,

		/**
		 * DELETE Event.
		 */
		DELETE;
	}
}
